Management API

Base Resource URL:

     https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/business-info

Description:

Represents business information of the merchant.

Available sub-resources:

Resource URL Description
https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/business-info/primary-owner    The principal owner of the company, who has decision-making power and holds major percentage of stock.
https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/business-info/primary-reference    Information on the organization which can function as a reference for the merchant\reseller under consideration.
https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/business-info/secondary-owner    Co-owner of the company (in cases when there is more than one owner within a company).
https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/business-info/verification-result    Result of the background verification for the business. Can be used to analyze any underwriting/provisioning related issues.

Supported Actions:

copyContactsFrom  
Method:  GET       Implicit:  No       Returns:  ServiceResponse      
Consumes:  json, xml, xurl  Produces:  json, xml 
 
Copies address information from the specified object.


delete  
Method:  DELETE       Implicit:  Yes       Returns:  n/a      
Consumes:  xurl  Produces:  json, xml 
 
Deletes business information of the merchant


load  
Method:  GET       Implicit:  Yes       Returns:  BusinessInfo *      
Consumes:  xurl  Produces:  json, xml 
 
Loads business information of the merchant


modify  
Method:  POST       Implicit:  Yes       Returns:  BusinessInfo *      
Consumes:  json, xml, xurl  Produces:  json, xml 
 
Updates business information of the merchant

Parameters:
# Name Type Required Default Description
01 object BusinessInfo * Yes Updated object information.

Represents fields reflecting business information for a merchant.
02 externalSynchronizationPolicy BusinessInfo * No Defines whether a merchant is synchronized with external informational systems or not.

Represents fields reflecting business information for a merchant.